Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); try { // using this method you can get a list of locations // GET /v3/business_data/tripadvisor/locations/$country $result = $client->get('/v3/business_data/tripadvisor/locations/gb'); print_r($result); // do something with result } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20220216", "status_code": 20000, "status_message": "Ok.", "time": "0.2176 sec.", "cost": 0, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "02171541-1535-0248-0000-97786532e1fd", "status_code": 20000, "status_message": "Ok.", "time": "0.1487 sec.", "cost": 0, "result_count": 32558, "path": [ "v3", "business_data", "tripadvisor", "locations" ], "data": { "api": "business_data", "function": "locations", "se": "tripadvisor" }, "result": [ { "location_code": 2158, "location_name": "Taiwan", "location_name_parent": null, "country_iso_code": "TW", "location_type": "Region" }, { "location_code": 2344, "location_name": "Hong Kong", "location_name_parent": null, "country_iso_code": "HK", "location_type": "Region" }, { "location_code": 20152, "location_name": "Antofagasta,Chile", "location_name_parent": "Chile", "country_iso_code": "CL", "location_type": "Region" }, { "location_code": 20153, "location_name": "Araucania,Chile", "location_name_parent": "Chile", "country_iso_code": "CL", "location_type": "Region" }, { "location_code": 20154, "location_name": "Bio Bio,Chile", "location_name_parent": "Chile", "country_iso_code": "CL", "location_type": "Region" }, { "location_code": 20155, "location_name": "Coquimbo,Chile", "location_name_parent": "Chile", "country_iso_code": "CL", "location_type": "Region" } ] } ] }
You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
You can also download the full list of supported locations in the CSV format (last updated 2024-07-17).
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
country |
string | country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the parameters passed in the URL of the GET request |
result |
array | array of results |
location_code |
integer | location code |
location_name |
string | full name of the location |
location_name_parent |
string | the name of the superordinate location example: "location_code": 9041134,
|
country_iso_code |
string | ISO country code of the location |
location_type |
string | location type |